@pexip/plugin-api

Enumerations

• CallType

Classes

• Channel

Interfaces

• ApplicationMessage
• BreakoutReferDetails
• BreakoutRoom
• Button
• ButtonRPCPayload
• ChecklistElement
• ConferenceStatus
• EventMessage
• Form
• GroupButtonPayload
• IframeInitPosition
• InfinityParticipant
• InputElement
• LayoutEvent
• Message
• Participant
• Plugin
• PluginElement
• PluginMeta
• Prompt
• RPCCallMeta
• RPCCalls
• RadioGroupElement
• RangeSliderElement
• SelectElement
• Stage
• TextArea
• TransferDetails
• UIRPCCalls

Type Aliases

ButtonRPCReply

Ƭ ButtonRPCReply<T>: { data: T ; id: string ; status: "ok" } | { id: string ; reason: "Invalid Icon name" ; status: "failed" }

Type parameters

Name	Type
T	extends Record<string, unknown> | undefined = undefined

---

ChecklistOption

Ƭ ChecklistOption: Object

Type declaration

Name	Type
checked?	boolean
id	string
label	string
required?	boolean

---

ClientSideErrorMessage

Ƭ ClientSideErrorMessage: "Could not reconnect to the meeting" | "Could not execute critical network action" | "Could not find ICE candidates" | "WebRTC connection closed" | "WebRTC connection failed"

---

ConferenceStatusEvent

Ƭ ConferenceStatusEvent: ConferenceStatusMap["200"][``"result"``]

---

CustomIcon

Ƭ CustomIcon: Object

Type declaration

Name	Type
hover	string
main	string

---

DisconnectReason

Ƭ DisconnectReason: "Browser closed" | "User initiated disconnect"

---

Event

Ƭ Event<T>: T extends keyof EventMessage ? { chanId: string ; event: T ; payload: EventMessage[T][``"payload"``] } : never

Type parameters

Name	Type
T	extends keyof EventMessage = keyof EventMessage

---

EventPayload

Ƭ EventPayload<T>: Event<T>["payload"]

Type parameters

Name	Type
T	extends keyof EventMessage

---

ExtendedInfinityErrorCode

Ƭ ExtendedInfinityErrorCode: InfinityErrorCode | "#pex128" | "#pex117"

---

ExtendedInfinityErrorMessage

Ƭ ExtendedInfinityErrorMessage: InfinityErrorMessage | ClientSideErrorMessage

---

FormElement

Ƭ FormElement: InputElement | SelectElement | ChecklistElement | TextArea | RadioGroupElement | RangeSliderElement

---

FormInput

Ƭ FormInput: Record<string, FormInputValue>

---

FormInputId

Ƭ FormInputId: string

---

FormInputValue

Ƭ FormInputValue: string | number | Record<string, unknown>

---

FormPayload

Ƭ FormPayload: Object

Type declaration

Name	Type
description?	string
form	{ elements: Record<string, FormElement> ; submitBtnTitle: string }
form.elements	Record<string, FormElement>
form.submitBtnTitle	string
opensPopup?	PopupRequest
title	string

---

GenericRPCReply

Ƭ GenericRPCReply<T>: { data: T ; id: string ; status: "ok" } | { id: string ; reason: string ; status: "failed" }

Type parameters

Name	Type
T	extends Record<string, unknown> | undefined = undefined

---

GetButtonRPCPayload

Ƭ GetButtonRPCPayload<P, K>: ButtonRPCPayload[K][`P`]

Type parameters

Name	Type
P	extends keyof ButtonRPCPayload[K]
K	extends keyof ButtonRPCPayload = keyof ButtonRPCPayload

---

IframeProps

Ƭ IframeProps: { id: string ; type: "sidePanel" ; url: string } | { headerTitle?: string ; id: string ; initPosition?: IframeInitPosition ; type: "draggable" | "fixed" ; url: string }

---

IframeType

Ƭ IframeType: "sidePanel" | "draggable" | "fixed"

---

InfinityEndpointReply

Ƭ InfinityEndpointReply<T>: InfinityClient[T] extends (...args: never) => unknown ? Awaited<ReturnType<InfinityClient[T]>> : never

Type parameters

Name	Type
T	extends keyof InfinityClient

---

Layout

Ƭ Layout: TransformLayoutMap["Body"][``"transforms"``]["layout"]

---

MapFormReturn

Ƭ MapFormReturn<P>: { [K in keyof P]: "number" extends P[K]["type"] ? number : "checklist" extends P[K]["type"] ? Record<string, boolean> : string }

Type parameters

Name	Type
P	extends RPCCallPayload<"ui:form:open">["form"][``"elements"``] = Record<string, FormElement>

---

NotificationToastMessage

Ƭ NotificationToastMessage: Object

Type declaration

Name	Type	Description
canDismiss?	boolean	-
isDanger?	boolean	-
isInterrupt?	boolean	A toast that can interrupt will jump the queue and remove the currently rendering toast and be rendered instead of it. Currently rendering toasts that have a timeout of 0 cannot be interrupted, the toast that tries to interrupt it is discarded and not queued. An example when this can be useful: if many toasts are sent rapidly in response to UI state changes; User mutes, unmute & mutes again and toasts are displayed to reflect these states, the toasts will display without a long timeout between each.
message	string	-
position?	"topCenter" | "bottomCenter"	-
timeout?	number	-

---

ParamsWithOmittedConferenceMeta

Ƭ ParamsWithOmittedConferenceMeta<T>: InfinityClient[T] extends (...args: never) => unknown ? Omit<Parameters<InfinityClient[T]>[0], "conferenceAlias" | "host"> : never

Type parameters

Name	Type
T	extends keyof InfinityClient

---

PluginIframe

Ƭ PluginIframe<T>: T extends "sidePanel" ? { element: HTMLIFrameElement ; type: T } : { element: HTMLIFrameElement ; headerTitle?: string ; initPosition: IframeInitPosition ; type: T }

Type parameters

Name	Type
T	extends IframeType = IframeType

---

PluginMessage

Ƭ PluginMessage: Event | RPCReply

---

PopupRequest

Ƭ PopupRequest: Object

Type declaration

Name	Type
id	string
openParams	Parameters<Window["open"]>

---

RPCCall

Ƭ RPCCall<T>: T extends keyof RPCCalls ? { chanId: string ; id: string ; payload: RPCCalls[T][``"payload"``] ; rpc: T } : never

Type parameters

Name	Type
T	extends keyof RPCCalls = keyof RPCCalls

---

RPCCallPayload

Ƭ RPCCallPayload<T>: RPCCall<T>["payload"]

Type parameters

Name	Type
T	extends keyof RPCCalls

---

RPCCallReply

Ƭ RPCCallReply<T>: RPCReply<T>["payload"]

Type parameters

Name	Type
T	extends keyof RPCCalls

---

RPCReply

Ƭ RPCReply<T>: T extends keyof RPCCalls ? { chanId: string ; payload: RPCCalls[T][``"reply"``] ; replyTo: string ; rpc: T } : never

Type parameters

Name	Type
T	extends keyof RPCCalls = keyof RPCCalls

---

RTCParticipantEvent

Ƭ RTCParticipantEvent: ParticipantsMap["200"][``"result"``][0]

---

RadioOption

Ƭ RadioOption: Object

Type declaration

Name	Type
id	string
isDisabled?	boolean
label	string
value	string

---

RoomID

Ƭ RoomID: string

---

ToolbarButtonPayload

Ƭ ToolbarButtonPayload: Object

Type declaration

Name	Type
icon	string | { custom: CustomIcon }
isActive?	boolean
opensPopup?	PopupRequest
position	"toolbar"
roles?	("chair" | "guest")[]
tooltip	string

---

UIError

Ƭ UIError: Object

Type declaration

Name	Type
reason	string

Functions

isEvent

▸ isEvent(data): data is Event

Parameters

Name	Type
data	unknown

Returns

data is Event

---

isFormChecklistElement

▸ isFormChecklistElement(element): element is ChecklistElement

Parameters

Name	Type
element	FormElement

Returns

element is ChecklistElement

---

isFormInputElement

▸ isFormInputElement(element): element is InputElement | TextArea

Parameters

Name	Type
element	FormElement

Returns

element is InputElement | TextArea

---

isFormRadioGroupElement

▸ isFormRadioGroupElement(element): element is RadioGroupElement

Parameters

Name	Type
element	FormElement

Returns

element is RadioGroupElement

---

isFormRangeElement

▸ isFormRangeElement(element): element is FormElement

Parameters

Name	Type
element	FormElement

Returns

element is FormElement

---

isFormSelectElement

▸ isFormSelectElement(element): element is SelectElement

Parameters

Name	Type
element	FormElement

Returns

element is SelectElement

---

isRPCCall

▸ isRPCCall(data): data is RPCCall

Parameters

Name	Type
data	unknown

Returns

data is RPCCall

---

isRPCCallType

▸ isRPCCallType<T>(type, data): data is RPCCall<T>

Type parameters

Name	Type
T	extends keyof RPCCalls

Parameters

Name	Type
type	T
data	RPCCall<T>

Returns

data is RPCCall<T>

---

isRPCReply

▸ isRPCReply(data): data is RPCReply

Parameters

Name	Type
data	unknown

Returns

data is RPCReply

---

registerPlugin

▸ registerPlugin(meta): Promise<Plugin>

Parameters

Name	Type
meta	PluginMeta

Returns

Promise<Plugin>

---

setLogger

▸ setLogger(newLogger): void

Parameters

Name	Type
newLogger	Logger

Returns

void